home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / basic / rtx.exe / RTXGUIDE.TXT < prev    next >
Text File  |  1992-09-02  |  90KB  |  2,988 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                    R t x   P r o f e s s i o n a l   T o o l b o x
  22.  
  23.                            Report Toolbox for Microsoft PDS
  24.  
  25.  
  26.  
  27.                                   ------------------
  28.                                   PROGRAMMER'S GUIDE
  29.                                   ------------------
  30.  
  31.  
  32.  
  33.                                   Cyberphilia, Inc.
  34.                                  1465 Midland Avenue
  35.                               Bronxville, NY 10708-6035
  36.  
  37.  
  38.                                    -- Telephones --
  39.  
  40.                             7 Days a week, 24 hours a day:
  41.  
  42.                           In New York City Metropolitan Area
  43.                                     (800) 300-2018
  44.  
  45.                                       Elsewhere
  46.                                     (914) 337-8322
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.                                   TABLE OF CONTENTS
  55.  
  56.  
  57.         INTRODUCTION  . . . . . . . . . . . . . . . . . . . . . . . . . .   i
  58.  
  59.         ABOUT THE AUTHORS . . . . . . . . . . . . . . . . . . . . . . . .  ii
  60.  
  61.         SHAREWARE NOTICE  . . . . . . . . . . . . . . . . . . . . . . . .  iv
  62.  
  63.         COMPILING & LINKING WITH RTX  . . . . . . . . . . . . . . . . . .   v
  64.  
  65.         TUTORIAL  . . . . . . . . . . . . . . . . . . . . . . . . . . . .   1
  66.              EXAMPLE USING BINARY DATA FILE . . . . . . . . . . . . . . .   3
  67.              EXAMPLE USING ISAM DATA FILE . . . . . . . . . . . . . . . .  11
  68.              THE RESULTING OUTPUT . . . . . . . . . . . . . . . . . . . .  14
  69.  
  70.         TOOLBOX REFERENCE . . . . . . . . . . . . . . . . . . . . . . . .  15
  71.              RtxClose . . . . . . . . . . . . . . . . . . . . . . . . . .  16
  72.              RtxData  . . . . . . . . . . . . . . . . . . . . . . . . . .  17
  73.              RtxGetBreak  . . . . . . . . . . . . . . . . . . . . . . . .  18
  74.              RtxGetPage . . . . . . . . . . . . . . . . . . . . . . . . .  19
  75.              RtxGetRemaining  . . . . . . . . . . . . . . . . . . . . . .  20
  76.              RtxInit  . . . . . . . . . . . . . . . . . . . . . . . . . .  21
  77.              RtxNewPage . . . . . . . . . . . . . . . . . . . . . . . . .  22
  78.              RtxOpen  . . . . . . . . . . . . . . . . . . . . . . . . . .  23
  79.              RtxOutput  . . . . . . . . . . . . . . . . . . . . . . . . .  24
  80.              RtxResult  . . . . . . . . . . . . . . . . . . . . . . . . .  25
  81.              RtxSetBreak  . . . . . . . . . . . . . . . . . . . . . . . .  26
  82.              RtxSetBreak0 . . . . . . . . . . . . . . . . . . . . . . . .  27
  83.              RtxSetColumn . . . . . . . . . . . . . . . . . . . . . . . .  28
  84.              RtxSetError  . . . . . . . . . . . . . . . . . . . . . . . .  30
  85.              RtxSetFooting  . . . . . . . . . . . . . . . . . . . . . . .  31
  86.              RtxSetForm . . . . . . . . . . . . . . . . . . . . . . . . .  32
  87.              RtxSetHeading  . . . . . . . . . . . . . . . . . . . . . . .  34
  88.              RtxSetPrinter  . . . . . . . . . . . . . . . . . . . . . . .  35
  89.              RtxSkip  . . . . . . . . . . . . . . . . . . . . . . . . . .  36
  90.              RtxSuppress  . . . . . . . . . . . . . . . . . . . . . . . .  37
  91.  
  92.         APPENDIX A - RESULT CODES . . . . . . . . . . . . . . . . . . . .  40
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  100.         =====================================================================
  101.  
  102.                                      INTRODUCTION
  103.  
  104.         Rtx Professional  Toolbox is a  library for Microsoft PDS  v7.x which
  105.         enables   programmers    to   add    professional-quality   reporting
  106.         capabilities to their applications with ease.
  107.  
  108.         When Microsoft  introduced the  User Interface  Toolbox, Presentation
  109.         Graphics Toolbox and PROISAM into PDS, it instantly became a credible
  110.         environment  to create top  quality business applications.   However,
  111.         despite  all   their  enhancements   to  PDS   for  improved   screen
  112.         presentation and storage  of data, only LPRINT exists  to output that
  113.         data to a  piece of paper.  Rtx was written to compliment Microsoft's
  114.         enhancements to PDS and complete the picture.
  115.  
  116.         Using a few simple calls to the Rtx library, you can quickly set up a
  117.         business report format.  Once you have, just pass it the raw data and
  118.         it takes care  of the  rest.   Rtx handles page  breaks, headers  and
  119.         footers, formatting and subtotalling columnar data and much more.
  120.  
  121.         Rtx is distributed on bulletin boards or from shareware houses as one
  122.         compressed  .ZIP  file:  RTX.ZIP.     It  contains  the  Rtx  library
  123.         (RTX.LIB),  this document  (RTXGUIDE.TXT), product  registration form
  124.         (REGISTER.TXT), and  two header files  which you must include  at the
  125.         top of any program you create which uses Rtx (RTX.BI, RTXMEM.BI).
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.         =====================================================================
  152.         Copyright 1992 by Cyberphilia, Inc.                          Page [i]
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  160.         =====================================================================
  161.  
  162.                                   ABOUT THE AUTHORS
  163.  
  164.         Cyberphilia, Inc.  is a small  computer consulting firm based  in the
  165.         New York City area.  Established originally by Carlos-Manuel Abreu as
  166.         a one-man show in  1983, now in our 10th  year we're still only  five
  167.         consultants strong.
  168.  
  169.         Cyberphilia is committed to providing affordable, effective  contract
  170.         programming and  consultancy services to  businesses in the  New York
  171.         area.  To do so, we remain a small, tight-knit group working from our
  172.         homes.  We're  joined by CyberNet,  workgroup software developed  in-
  173.         house  for our own  use.  With CyberNet  we exchange electronic mail,
  174.         co-develop software  and  documentation, and  distribute  and  handle
  175.         technical assistance calls.
  176.  
  177.         The release of  our Professional Toolbox product line  is a departure
  178.         for  us.    Until now,  all  the  toolboxes  we've  created were  for
  179.         exclusive use  in the software  we write for our  clients.  Recently,
  180.         however,  we decided  to market  these  toolboxes as  shareware.   We
  181.         supply full  source code  in Microsoft PDS  v7.1 to  registered users
  182.         along with  exhaustive documentation.   Source code is  supplied with
  183.         the  understanding that  it  is  for your  personal  use  and can  be
  184.         modified to suit your needs and recompiled for  inclusion in your own
  185.         end-user applications.   We strictly forbid,  however, redistributing
  186.         the source  code, in whole or in part.   Furthermore, the source code
  187.         cannot be used to build another library for subsequent sale.  Each of
  188.         our  toolboxes represents long hours of  design work and programming;
  189.         we've burned  a lot of midnight oil.   We trust you'll understand our
  190.         desire to protect  a lot hard work.   Besides, it wouldn't be  a very
  191.         nice thing to do.  You wouldn't like it if we did it to you, eh?
  192.  
  193.         Rtx is our first toolbox to be released as shareware.  We're sprucing
  194.         up the others now and are wrapping up the documentation.  In a minute
  195.         we'll fill  you in on other exciting toolboxes  that are on their way
  196.         from Cyberphilia, Inc. during 1992.
  197.  
  198.         We sincerely hope  that you'll find our  toolboxes useful and  opt to
  199.         register.  We're anxious to hear from you, so drop us a line.  Caveat
  200.         Emptor: We're a little wacky.  (In this business, who isn't?)
  201.  
  202.         Carlos-Manuel Abreu ("Chuck")
  203.         Joseph DiMuro ("Joe")
  204.         John Owens ("Jack")
  205.         Elisa Medina ("Lisa")
  206.         Peter McGahan ("Pete")
  207.  
  208.  
  209.  
  210.  
  211.         =====================================================================
  212.         Copyright 1992 by Cyberphilia, Inc.                         Page [ii]
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  220.         =====================================================================
  221.  
  222.                       OTHER SHAREWARE PRODUCTS FROM CYBERPHILIA
  223.  
  224.  
  225.         Mtx Professional Toolbox                    Available September, 1992
  226.  
  227.              Add memo fields to  your data files and ISAM databases.   Allows
  228.              you  to associate free-form, variable-length text fields to your
  229.              fixed-length data records.   Why say COMMENTS AS  STRING*30 when
  230.              you can say COMMENTS AS MEMO?
  231.  
  232.  
  233.         Xtx Professional Toolbox                    Available September, 1992
  234.  
  235.              Our Xtx toolbox allows  you to import from and export  to a wide
  236.              variety of commonly  used file formats.  Read and write Lotus 1-
  237.              2-3 files,  DBASE (XBASE) files,  mail-merge files and  more all
  238.              under your direct program control.
  239.  
  240.  
  241.         Btx Professional Toolbox                      Available October, 1992
  242.  
  243.              Our business toolbox  provides you with core  accounting modules
  244.              which  allow  you  to   quickly  assemble  complete  interactive
  245.              business applications.  Modules include General Ledger, Accounts
  246.              Receivable, Accounts Payable, Payroll, Job Costing and Financial
  247.              Reporting.
  248.  
  249.  
  250.         Dtx Professional Toolbox                     Available November, 1992
  251.  
  252.              Add   a  sophisticated  text   retrieval  engine  to   your  PDS
  253.              applications.    Allows   you  to   create  document   databases
  254.              programmatically from source documents in ASCII and a variety of
  255.              popular  word   processor   formats.     Instantly  locate   all
  256.              occurrences of a word or phrase.  Dtx supports most  common text
  257.              retrieval operations, including:  stemming (automatic conflation
  258.              of words  to root  words), truncation  (manual conflation  using
  259.              wildcard characters), weighting  (indexing based on  statistical
  260.              distribution  of terms), stoplists (eliminate words that have no
  261.              indexing  value)  and  thesaurus  (conflation  using  synonymous
  262.              terms).
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.         =====================================================================
  272.         Copyright 1992 by Cyberphilia, Inc.                        Page [iii]
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  280.         =====================================================================
  281.  
  282.                                    SHAREWARE NOTICE
  283.  
  284.         Rtx Professional Toolbox is Shareware,  not freeware.  After a thirty
  285.         day  evaluation  period,  if  you continue  to  use  Rtx Professional
  286.         Toolbox,  you are  required to  register  the product  and include  a
  287.         license fee of $30.00 by  check or money order.  The license fee will
  288.         entitle you  to a copy  of the Rtx  Professional Toolbox  source code
  289.         (subject  to  terms), written  entirely  in Microsoft  PDS  v7.1, and
  290.         telephone support for 90 days after the date of purchase.
  291.  
  292.         To register, print  out the registration form,  REGISTER.TXT included
  293.         with  RTX.ZIP.   Fill in  your  name, company  name (if  applicable),
  294.         address, city,  state, zip code and telephone number  at the top.  In
  295.         order to receive  Rtx source code,  you must read  and sign the  non-
  296.         disclosure statement  found at the  bottom of the  registration form.
  297.         Mail the  completed form  along with  your check  or money  order for
  298.         $30.00 to:
  299.  
  300.                                   Cyberphilia, Inc.
  301.                                  1465 Midland Avenue
  302.                               Bronxville, NY 10708-6035
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.         =====================================================================
  332.         Copyright 1992 by Cyberphilia, Inc.                         Page [iv]
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  340.         =====================================================================
  341.  
  342.                              COMPILING & LINKING WITH RTX
  343.  
  344.         To  use Rtx in your  applications, you must  include the RTX.BI file,
  345.         distributed with the  toolbox, at the top  of your source  code among
  346.         the   declarations.    It   contains  the  subprogram   and  function
  347.         declarations necessary  to call  Rtx procedures.   Additionally,  you
  348.         must include the RTXMEM.BI file at the top of your source  code among
  349.         your memory  allocation statements.   It  dimensions commonly  shared
  350.         global arrays that Rtx uses to store active report information.
  351.  
  352.         Please do not make  any modifications to these header files.   It may
  353.         seem  at first  that  you  can change  the  MaxColumns constant,  for
  354.         example, to accommodate more columns  on your reports, however  doing
  355.         so  will corrupt  the  aforementioned  shared  memory  block  because
  356.         MaxColumns is already  "etched in stone" in RTX.LIB.  If you register
  357.         with us you'll receive the complete Rtx source code.  With the source
  358.         code on hand,  you can modify these  files as needed because  you can
  359.         always recompile the Rtx with the new parameters.
  360.  
  361.         When linking your  programs to produce final executables, you'll have
  362.         to include  RTX.LIB, QBX.LIB and  DTFMTER.LIB.  RTX.LIB  contains the
  363.         actual Rtx procedures.   QBX.LIB is needed because Rtx  uses the Call
  364.         Interrupt  procedure.  Finally,  DTFMTER.LIB is required  because Rtx
  365.         uses the procedures contained therein to format data to be printed on
  366.         reports.
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.         =====================================================================
  392.         Copyright 1992 by Cyberphilia, Inc.                          Page [v]
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  400.         =====================================================================
  401.  
  402.                                        TUTORIAL
  403.  
  404.         The easiest way to  learn how to use Rtx is by example.  The upcoming
  405.         pages  present a  simple  application  and  a  detailed  line-by-line
  406.         explanation.  Please refer to the TOOLBOX REFERENCE section elsewhere
  407.         in this document  for more detailed information on  all available Rtx
  408.         entry points.
  409.  
  410.         Assume you're  writing accounting  software and need  to give  it the
  411.         capability  to produce a cash disbursements journal from its accounts
  412.         payable module.   Each transaction record  would minimally contain  a
  413.         Transaction Date, Payee's ID Number, Check Number, Account Number and
  414.         an Amount.  For the purposes of this example we'll use  the following
  415.         record structure for the data ...
  416.  
  417.         Type TransactionStruc              ' Transaction record structure
  418.           Date    As String*6              '   6-digit date as YYMMDD
  419.           Payee   As String*4              '   4-digit payee or vendor ID
  420.           Check   As String*4              '   4-digit check number
  421.           Account As String*5              '   5-digit account number
  422.           Amount  As Currency              '   Amount as currency
  423.         End Type
  424.  
  425.         ... and say that the data file contains the following data ...
  426.  
  427.         REC#  -DATE-  PAYEE  CHECK  ACCOUNT  -AMOUNT-
  428.            1  911001   1234   1001    20450    100.00
  429.            2  911001   1235   1002    20451    150.00
  430.            3  911001   1401   1003    20452    125.00
  431.            4  911001   1401   1004    20450    110.00
  432.            5  911001   1402   1005    20451    205.00
  433.            6  911002   1260   1007    20450    190.00
  434.            7  911002   1261   1008    20451    175.00
  435.            8  911002   1261   1009    20452    160.00
  436.            9  911002   1261   1010    20450    155.00
  437.  
  438.         ... and  say that  we'd like  the report  to  print the  information,
  439.         totalling transactions by  date and subtotalling them by payee within
  440.         each date.
  441.  
  442.         The key to understanding Rtx can be found in the dynamics of the data
  443.         with which it  is supplied.  Notice  how the data in the  Date column
  444.         changes from record 5 (911001)  to 6 (911002).  This is  known to Rtx
  445.         as  a "break," that is, a break in  the flow of the column's data.  A
  446.         break also occurs several times in the Payee column and in every case
  447.         of the  Amount column.    Even though  Rtx recognizes  breaks in  all
  448.         columns, only the first two are of any interest to us in this example
  449.  
  450.  
  451.         =====================================================================
  452.         Copyright 1992 by Cyberphilia, Inc.                          Page [1]
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  460.         =====================================================================
  461.  
  462.         because we want  Rtx to stop and  print totals when a  break in these
  463.         columns occurs.
  464.  
  465.         Initially Rtx  recognizes no  special handling  for columnar  breaks.
  466.         Calls to the  RtxSetBreak procedure dictate action to  be taken (e.g.
  467.         inserting subtotals, skipping lines,  or jumping to the top of  a new
  468.         page) when  a break in  specific columns  occur.   The upcoming  code
  469.         samples, though simplistic, clearly demonstrate how  we might use Rtx
  470.         to generate our sample report.  The  line numbers at the left are for
  471.         documentation  purposes only  here,  and  are not  part  of the  code
  472.         itself.  A detailed explanation appears after the program listing.
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.         =====================================================================
  512.         Copyright 1992 by Cyberphilia, Inc.                          Page [2]
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  520.         =====================================================================
  521.  
  522.                             EXAMPLE USING BINARY DATA FILE
  523.  
  524.         Data must  be supplied to Rtx in the order in which it is to print on
  525.         the final  report for  it to  correctly determine  breaks.   In  this
  526.         example, the data  stored in the file  is already sorted by  date and
  527.         then by payee within each date.
  528.  
  529.  
  530.         [01] | '$Include: 'Rtx.Bi'
  531.              | '
  532.         [02] | Const TRNRecSiz = 27
  533.              | '
  534.         [03] | '$Include: 'RtxMem.Bi'
  535.              | '
  536.         [04] | Type TransactionStruc
  537.              |   Date    As String*6
  538.              |   Payee   As String*4
  539.              |   Check   As String*4
  540.              |   Account As String*5
  541.              |   Amount  As Currency
  542.              | End Type
  543.              | '
  544.         [05] | Dim _
  545.              |   TRN  As TransactionStruc, _
  546.              |   I    As Integer, _
  547.              |   Recs As Integer
  548.              |   '
  549.         [06] | DataFile = FreeFile
  550.         [07] | Open "TEST.DAT" For Binary As DataFile
  551.              | '
  552.         [08] | RtxInit
  553.              | '
  554.         [09] | RtxSetPrinter 1
  555.         [10] | RtxSetError 25
  556.         [11] | RtxSetForm 80, 66, 0, 3, 3
  557.              | '
  558.         [12] | RtxSetHeading 1, "CASH DISBURSEMENTS JOURNAL", 2
  559.              | RtxSetHeading 2, "=", 0
  560.              | RtxSetHeading 3, "", 0
  561.              | '
  562.         [13] | RtxSetFooting 1, "", 0
  563.              | RtxSetFooting 2, "=", 0
  564.              | RtxSetFooting 3, "Date: " + Date$ + "  Page: ^P", 1
  565.              | '
  566.         [14] | RtxSetColumn 1, "Date",    1, "########",  0, False, True
  567.              | RtxSetColumn 2, "Payee",   1, "#####",     1, False, True
  568.              | RtxSetColumn 3, "Check",   1, "#####",     1, False, False
  569.              | RtxSetColumn 4, "Account", 1, "#######",   1, False, False
  570.  
  571.         =====================================================================
  572.         Copyright 1992 by Cyberphilia, Inc.                          Page [3]
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  580.         =====================================================================
  581.  
  582.              | RtxSetColumn 5, "Amount",  6, "#####0.00", 1, True,  False
  583.              | '
  584.         [15] | RtxSetBreak 1, 1, 2, "DATE TOTALS"
  585.              | RtxSetBreak 2, 2, 1, "PAYEE TOTALS"
  586.              | '
  587.         [16] | RtxSetBreak0 "REPORT TOTALS"
  588.              |
  589.         [17] | RtxOpen "TEST.TXT", True
  590.         [18] | If RtxResult = RTXSUCCESS Then
  591.         [19] |   Recs = Lof(DataFile) \ TRNRecSiz
  592.         [20] |   For I = 1 To Recs
  593.         [21] |     Get #DataFile,, TRN
  594.         [22] |     RtxData 1, Mid$(TRN.Date, 3, 2) + "/" + _
  595.              |       Right$(TRN.Date, 2)  + "/" + Left$(TRN.Date, 2)
  596.         [23] |     RtxData 2, TRN.Payee
  597.         [24] |     RtxData 3, TRN.Check
  598.         [25] |     RtxData 4, TRN.Account
  599.         [26] |     RtxData 5, Mkc$(TRN.Amount)
  600.         [27] |     RtxOutput
  601.         [28] |   Next I
  602.         [29] |   RtxClose 3, True
  603.         [30] | End If
  604.              | '
  605.         [31] | Close DataFile
  606.         [32] | End
  607.  
  608.  
  609.                                  DETAILED EXPLANATION
  610.  
  611.         [01] '$Include: 'Rtx.Bi'
  612.  
  613.              The  Rtx  header  file must  be  included  at  the  top  of  any
  614.              application you write that  uses Rtx.  It includes  Rtx-specific
  615.              constants, procedure, function and global memory declarations.
  616.  
  617.  
  618.         [02] TRNRecSiz = 27
  619.  
  620.              Declares the size,  in bytes, of the transaction  records in the
  621.              data file.
  622.            
  623.           
  624.         [03] '$Include: 'RtxMem.Bi'
  625.  
  626.              Allocates global arrays.
  627.  
  628.              This statement  must appear  exactly as  it appears  immediately
  629.              following your declarations (non-executing statements).   Do not
  630.  
  631.         =====================================================================
  632.         Copyright 1992 by Cyberphilia, Inc.                          Page [4]
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  640.         =====================================================================
  641.  
  642.              change any constants (such as  MaxHeaders) in the Rtx.Bi file as
  643.              unpredictable   errors  will  occur.    Changing  them  in  your
  644.              application will  not change the  constants used by  the library
  645.              which are "etched in stone."
  646.  
  647.  
  648.         [04] Type TransactionStruc
  649.                Date    As String*6
  650.                Payee   As String*4
  651.                Check   As String*4
  652.                Account As String*5
  653.                Amount  As Currency
  654.              End Type
  655.  
  656.              Declares the structure of data records in the file.
  657.  
  658.  
  659.         [05] Dim _
  660.                TRN  As TransactionStruc, _
  661.                I    As Integer, _
  662.                Recs As Integer
  663.  
  664.              Allocates a buffer to contain  data retrieved from the file, and
  665.              declares both an integer local loop counter and integer variable
  666.              to hold the number of records in the data file.
  667.  
  668.  
  669.         [06] DataFile = FreeFile
  670.  
  671.              Obtains a free file handle.
  672.  
  673.  
  674.         [07] Open "TEST.DAT" For Binary As DataFile
  675.  
  676.              Opens the data file for binary access on the acquired  free file
  677.              handle.
  678.  
  679.  
  680.         [08] RtxInit
  681.  
  682.              Initializes the Rtx system.  RtxInit must be called before using
  683.              the Rtx system.
  684.  
  685.  
  686.  
  687.         [09] RtxSetPrinter 1
  688.  
  689.  
  690.  
  691.         =====================================================================
  692.         Copyright 1992 by Cyberphilia, Inc.                          Page [5]
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  700.         =====================================================================
  701.  
  702.              Informs Rtx that LPT1 is  to be used for printing hardcopies  of
  703.              report images.  LPT1 through LPT3 are supported.
  704.  
  705.  
  706.  
  707.         [10] RtxSetError 25
  708.  
  709.              Informs Rtx that when printing hardcopies, screen line 25 should
  710.              be used  to display informational  messages and  prompts to  the
  711.              user when  errors occur during  printing, such as paper  jams or
  712.              when the printer is out of paper.  This is known as "interactive
  713.              error handling."  If this had been set to  0 and an error occurs
  714.              during printing, Rtx would simply  cancel printing and return  a
  715.              result code  to the  application  indicating the  nature of  the
  716.              error, in effect disabling interactive error handling.
  717.  
  718.  
  719.         [11] RtxSetForm 80, 66, 0, 3, 3
  720.  
  721.              Characteristics of  the output form  are defined here.   In this
  722.              case the statement  reads "80 characters across,  66 lines down,
  723.              no  left margin, top  margin is 3  lines and bottom  margin is 3
  724.              lines."
  725.  
  726.  
  727.         [12] RtxSetHeading 1, "CASH DISBURSEMENTS JOURNAL", 2
  728.              RtxSetHeading 2, "=", 0
  729.              RtxSetHeading 3, "", 0
  730.  
  731.              Defines report  header lines.   The  statements read  "The first
  732.              line of  the heading is  to be 'CASH DISBURSEMENTS  JOURNAL' and
  733.              should be  centered.  Fill  the second report heading  line with
  734.              equal signs to achieve a horizontal double line.  The final line
  735.              is blank."
  736.  
  737.  
  738.         [13] RtxSetFooting 1, "", 0
  739.              RtxSetFooting 2, "=", 0
  740.              RtxSetFooting 3, "Date: " + Date$ + "  Page: ^P", 1
  741.  
  742.              Similar to RtxSetHeading, RtxSetFooting declares footer lines in
  743.              a top-down  fashion.  This statement defines a blank line as the
  744.              first footing line, the second a horizontal double line, and the
  745.              final the current date and page number, flush right.
  746.  
  747.  
  748.         [14] RtxSetColumn 1, "Date",    1, "########",  0, False, True
  749.              RtxSetColumn 2, "Payee",   1, "#####",     1, False, True
  750.  
  751.         =====================================================================
  752.         Copyright 1992 by Cyberphilia, Inc.                          Page [6]
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  760.         =====================================================================
  761.  
  762.              RtxSetColumn 3, "Check",   1, "#####",     1, False, False
  763.              RtxSetColumn 4, "Account", 1, "#######",   1, False, False
  764.              RtxSetColumn 5, "Amount",  6, "#####0.00", 1, True,  False
  765.  
  766.              Defines report  columns.   It is not  necessary that  columns be
  767.              defined  in  order,  but they  must  contiguous  (i.e.  once all
  768.              columns have been defined, there  cannot be any gaps between the
  769.              numbers.)  Columns  are  numbered from  left  to  right, with  a
  770.              maximum of 10 columns supported by Rtx.
  771.  
  772.              The statement for the first column reads "Set the column heading
  773.              to 'Date', the date will be  supplied as a string (1), mask  the
  774.              data  as 8 characters  in length ('########'),  print flush left
  775.              (0), do  not maintain or  print totals for this  column (False),
  776.              and  form a  hanging indent  (True) by  printing only  the first
  777.              occurrence of the column data  when two or more consecutive rows
  778.              have the same contents in this column."
  779.  
  780.              Rtx, when printing column headings, underlines them with hyphens
  781.              to the length of the mask.   If the heading text is longer  than
  782.              the mask it is truncated to the length of the mask.
  783.  
  784.              The statement for  the second column sets the  column heading to
  785.              'Payee',  specifies that  the Payee  ID  will be  supplied as  a
  786.              string  (1), the data will  be masked to  5 characters in length
  787.              ('#####'),  printing  will be  flush  right  (1),  it is  not  a
  788.              totalling  column (False)  and  should  form  a  hanging  indent
  789.              (True).
  790.  
  791.              The statement  for the third  column sets the column  heading to
  792.              'Check', specifies that  the Check Number will be  supplied as a
  793.              string (1), the data  will be masked to  5 characters in  length
  794.              ('#####'),  printing  will be  flush  right  (1),  it is  not  a
  795.              totalling  column (False)  and should  always  print (False,  no
  796.              hanging indent).
  797.  
  798.              The statement for  the fourth column sets the  column heading to
  799.              'Account', specifies that the Account Number will be supplied as
  800.              a string (1),  the data will be masked to 7 characters in length
  801.              ('#######'),  printing will  be flush  right  (1), it  is not  a
  802.              totalling  column (False)  and should  always  print (False,  no
  803.              hanging indent).
  804.  
  805.              The statement  for the final  column sets the column  heading to
  806.              'Amount', specifies that the Amount will be supplied as Currency
  807.              in string format using Mkc$() (6), the data will be masked  to 9
  808.              characters in  length, scaled  to two  digits after the  decimal
  809.              point ('#####0.00'), printing will be flush right (1), totals of
  810.  
  811.         =====================================================================
  812.         Copyright 1992 by Cyberphilia, Inc.                          Page [7]
  813.  
  814.  
  815.  
  816.  
  817.  
  818.  
  819.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  820.         =====================================================================
  821.  
  822.              this  column are to  be maintained and printed  at breaks set by
  823.              RtxSetBreak  (True) and should  always print (False,  no hanging
  824.              indent).
  825.  
  826.  
  827.         [15] RtxSetBreak 1, 1, -1, "DATE TOTALS"
  828.              RtxSetBreak 2, 2, 1,  "PAYEE TOTALS"
  829.  
  830.              Sets breaks in the report.   The statements read "Set  the first
  831.              break (1)  to trigger when there is a  break in the first column
  832.              (1,  Date), skip  to the  top of  the next  page after  printing
  833.              totals (-1,  page break)  and precede the  totals with  the text
  834.              'DATE TOTALS'.   Set the second break  (2) to trigger when there
  835.              is a break in  the second column (2, Payee), skip  one blank row
  836.              after printing totals  (1) and precede the totals  with the text
  837.              'PAYEE TOTALS'."
  838.  
  839.  
  840.         [16] RtxSetBreak0 "REPORT TOTALS"
  841.  
  842.              Sets special  break '0',  that is, the  final break  that occurs
  843.              when a report  is closed.  This statement  reads "Precede report
  844.              totals that print at the end of the report with the text 'REPORT
  845.              TOTALS.'"
  846.  
  847.  
  848.         [17] RtxOpen "TEST.TXT", True
  849.  
  850.              Opens  the file  to receive  the report  image  ('TEST.TXT') and
  851.              tells  Rtx to overwrite  any file with  the same name  (True) by
  852.              deleting it first.
  853.  
  854.  
  855.         [18] If RtxResult = RTXSUCCESS Then
  856.  
  857.              Tests  to  see  if  the  most  recent  Rtx  call  (RtxOpen)  was
  858.              successful.
  859.  
  860.  
  861.         [19] Recs = Lof(DataFile) \ TRNRecSiz
  862.  
  863.              Determines the number of transaction records in the data file by
  864.              performing an  integer divide of  the record size  constant into
  865.              the length of the data file.
  866.  
  867.  
  868.         [20] For I = 1 To Recs
  869.  
  870.  
  871.         =====================================================================
  872.         Copyright 1992 by Cyberphilia, Inc.                          Page [8]
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  880.         =====================================================================
  881.  
  882.              Loops through all records in the data file.
  883.  
  884.  
  885.         [21] Get #DataFile,, TRN
  886.  
  887.              Reads the current record into the TRN record buffer.
  888.  
  889.  
  890.         [22] RtxData 1, Mid$(TRN.Date, 3, 2) + "/" + _
  891.                Right$(TRN.Date, 2) + "/" + Left$(TRN.Date, 2)
  892.  
  893.              Sends data to be placed in column 1 to Rtx.  The statement reads
  894.              "The data for  column one of the  current row (1) is  the YYMMDD
  895.              date string (TRN.Date) formatted to MM/DD/YY.
  896.  
  897.  
  898.         [23] RtxData 2, TRN.Payee
  899.  
  900.              Sends the Payee ID string of the current record to be  placed in
  901.              column 2.
  902.  
  903.  
  904.         [24] RtxData 3, TRN.Check
  905.  
  906.              Sends the Check Number string of the current record to be placed
  907.              in column 3.
  908.  
  909.  
  910.         [25] RtxData 4, TRN.Account
  911.  
  912.              Sends  the Account  Number string  of the  current record  to be
  913.              placed in column 4.
  914.  
  915.  
  916.         [26] RtxData 5, Mkc$(TRN.Amount)
  917.  
  918.              Sends  the Amount  of the  current  record, which  is in  native
  919.              Currency type, as a string by first converting it with Mkc$().
  920.  
  921.  
  922.         [27] RtxOutput
  923.  
  924.              Outputs the  current row, formed  by prior calls to  RtxData, to
  925.              the report image  file, first  checking for  and processing  any
  926.              breaks that occur between the previous row at the pending one.
  927.  
  928.  
  929.         [28] Next I
  930.  
  931.         =====================================================================
  932.         Copyright 1992 by Cyberphilia, Inc.                          Page [9]
  933.  
  934.  
  935.  
  936.  
  937.  
  938.  
  939.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  940.         =====================================================================
  941.  
  942.              Continues to next iteration of read loop.
  943.  
  944.  
  945.         [29] RtxClose 3, True
  946.  
  947.              Indicates   that  report  is  complete.    The  statement  reads
  948.              "Terminate processing  the report,  print three  copies (3)  and
  949.              retain the report image file for possible use later (True).
  950.  
  951.  
  952.         [30] End If
  953.  
  954.              End of IF/END IF block on successful RtxOpen.
  955.  
  956.  
  957.         [31] Close DataFile
  958.         [32] End
  959.  
  960.              Closes the data file and ends the program.
  961.  
  962.  
  963.  
  964.  
  965.  
  966.  
  967.  
  968.  
  969.  
  970.  
  971.  
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.         =====================================================================
  992.         Copyright 1992 by Cyberphilia, Inc.                         Page [10]
  993.  
  994.  
  995.  
  996.  
  997.  
  998.  
  999.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1000.         =====================================================================
  1001.  
  1002.                              EXAMPLE USING ISAM DATA FILE
  1003.  
  1004.         Unlike  the example using a binary data file which requires that data
  1005.         is sorted  first, data  can be  extracted from  an ISAM  file in  the
  1006.         necessary order,  regardless of  how  it was  entered originally,  by
  1007.         using an index that is comprised of the concatenated transaction Date
  1008.         and Payee  ID.  Alpha markers [A..Z] on  the left highlight where the
  1009.         program differs from the binary file example
  1010.  
  1011.  
  1012.              | '$Include: 'Rtx.Bi'
  1013.              | '$Include: 'RtxMem.Bi'
  1014.              |   '
  1015.              | Type TransactionStruc
  1016.              |   Date    As String*6
  1017.              |   Payee   As String*4
  1018.              |   Check   As String*4
  1019.              |   Account As String*5
  1020.              |   Amount  As Currency
  1021.              | End Type
  1022.              | '
  1023.              | Dim _
  1024.              |   TRN  As TransactionStruc, _
  1025.              |   I    As Integer, _
  1026.              |   Recs As Integer
  1027.              |   '
  1028.         [A]  | Open "TEST.MDB" For ISAM TransactionStruc "CASH" As DataFile
  1029.         [B]  | CreateIndex DataFile, "DatePayee", False, "Date", "Payee"
  1030.         [C]  | SetIndex DataFile, "DatePayee"
  1031.              | '
  1032.              | RtxInit
  1033.              | '
  1034.              | RtxSetPrinter 1
  1035.              | RtxSetError 25
  1036.              | RtxSetForm 80, 66, 0, 3, 3
  1037.              | '
  1038.              | RtxSetHeading 1, "CASH DISBURSEMENTS JOURNAL", 2
  1039.              | RtxSetHeading 2, "=", 0
  1040.              | RtxSetHeading 3, "", 0
  1041.              | '
  1042.              | RtxSetFooting 1, "", 0
  1043.              | RtxSetFooting 2, "=", 0
  1044.              | RtxSetFooting 3, "Date: " + Date$ + "  Page: ^P", 1
  1045.              | '
  1046.              | RtxSetColumn 1, "Date",    1, "########",  0, False, True
  1047.              | RtxSetColumn 2, "Payee",   1, "#####",     1, False, True
  1048.              | RtxSetColumn 3, "Check",   1, "#####",     1, False, False
  1049.              | RtxSetColumn 4, "Account", 1, "#######",   1, False, False
  1050.  
  1051.         =====================================================================
  1052.         Copyright 1992 by Cyberphilia, Inc.                         Page [11]
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1060.         =====================================================================
  1061.  
  1062.              | RtxSetColumn 5, "Amount",  6, "#####0.00", 1, True,  False
  1063.              | '
  1064.              | RtxSetBreak 1, 1, 2, "DATE TOTALS"
  1065.              | RtxSetBreak 2, 2, 1, "PAYEE TOTALS"
  1066.              | '
  1067.              | RtxSetBreak0 "REPORT TOTALS"
  1068.              |
  1069.              | RtxOpen "TEST.TXT", True
  1070.              | If RtxResult = RTXSUCCESS Then
  1071.         [D]  |   MoveFirst DataFile
  1072.              |   Do While Not Eof(DataFile)
  1073.         [E]  |     Retrieve DataFile, TRN
  1074.              |     RtxData 1, Mid$(TRN.Date, 3, 2) + "/" + _
  1075.              |       Right$(TRN.Date, 2)  + "/" + Left$(TRN.Date, 2)
  1076.              |     RtxData 2, TRN.Payee
  1077.              |     RtxData 3, TRN.Check
  1078.              |     RtxData 4, TRN.Account
  1079.              |     RtxData 5, Mkc$(TRN.Amount)
  1080.              |     RtxOutput
  1081.         [F]  |     MoveNext DataFile
  1082.              |   Loop
  1083.              |   RtxClose 3, True
  1084.              | End If
  1085.              | '
  1086.         [G]  | DeleteIndex DataFile, "DatePayee"
  1087.              |
  1088.              | Close DataFile
  1089.              | End
  1090.  
  1091.  
  1092.                                  DETAILED EXPLANATION
  1093.  
  1094.         Only new or  changed lines which apply to ISAM  handling are detailed
  1095.         here.   Please read the  previous section "EXAMPLE USING  BINARY DATA
  1096.         FILE" first.
  1097.  
  1098.         [A]  Open "TEST.MDB" For ISAM TransactionStruc "CASH" As DataFile
  1099.  
  1100.              Opens the  ISAM data file,  indicating that records are  of type
  1101.              'TransactionStruc'  and the table within the file containing the
  1102.              cash disbursement transactions is called 'CASH'.
  1103.  
  1104.  
  1105.         [B]  CreateIndex DataFile, "DatePayee", False, "Date", "Payee"
  1106.  
  1107.              Creates a  sorted index for the table  comprised of the Date and
  1108.              Payee ID.  In doing so, records can be retrieved sequentially in
  1109.              Date and Payee order.
  1110.  
  1111.         =====================================================================
  1112.         Copyright 1992 by Cyberphilia, Inc.                         Page [12]
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1120.         =====================================================================
  1121.  
  1122.  
  1123.         [C]  SetIndex DataFile, "DatePayee"
  1124.  
  1125.              Makes the index just created the current one.
  1126.  
  1127.  
  1128.         [D]  MoveFirst DataFile
  1129.  
  1130.              Moves the  record pointer to the  first record in  the table, by
  1131.              index order.
  1132.  
  1133.  
  1134.         [E]  Retrieve DataFile, TRN
  1135.  
  1136.              Retrieves the current record into the TRN record buffer.
  1137.  
  1138.  
  1139.         [F]  MoveNext DataFile
  1140.  
  1141.              Moves  the record  pointer to the  next record in  the table, by
  1142.              index order.
  1143.  
  1144.  
  1145.         [G]  DeleteIndex DataFile, "DatePayee"
  1146.  
  1147.              Deletes the 'DatePayee' created earlier in the program.
  1148.  
  1149.  
  1150.  
  1151.  
  1152.  
  1153.  
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.         =====================================================================
  1172.         Copyright 1992 by Cyberphilia, Inc.                         Page [13]
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1180.         =====================================================================
  1181.  
  1182.                                  THE RESULTING OUTPUT
  1183.  
  1184.  
  1185.                               CASH DISBURSEMENTS JOURNAL
  1186.         =================================================================
  1187.                                                                          
  1188.         Date     Payee Check Account Amount
  1189.         -------- ----- ----- ------- ---------
  1190.         10/01/91  1234  1001   20450    100.00
  1191.  
  1192.                   1235  1002   20451    150.00
  1193.  
  1194.                   1401  1003   20452    125.00
  1195.                         1004   20450    110.00
  1196.                                      ---------
  1197.                         PAYEE TOTALS    235.00
  1198.  
  1199.                   1402  1005   20451    205.00
  1200.  
  1201.                                      ---------
  1202.                          DATE TOTALS    690.00
  1203.  
  1204.  
  1205.         10/02/91  1260  1007   20450    190.00
  1206.  
  1207.                   1261  1008   20451    175.00
  1208.                         1009   20452    160.00
  1209.                         1010   20450    155.00
  1210.                                      ---------
  1211.                         PAYEE TOTALS    490.00
  1212.  
  1213.                                      ---------
  1214.                          DATE TOTALS    680.00
  1215.  
  1216.  
  1217.                                      ---------
  1218.                        REPORT TOTALS   1370.00
  1219.  
  1220.         =================================================================
  1221.                                                 Date: 08-31-1992  Page: 1
  1222.  
  1223.  
  1224.         And there you have it.  Read  on for details on all Rtx entry  points
  1225.         available to you.
  1226.  
  1227.         Enjoy!
  1228.  
  1229.  
  1230.  
  1231.         =====================================================================
  1232.         Copyright 1992 by Cyberphilia, Inc.                         Page [14]
  1233.  
  1234.  
  1235.  
  1236.  
  1237.  
  1238.  
  1239.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1240.         =====================================================================
  1241.  
  1242.  
  1243.  
  1244.  
  1245.  
  1246.  
  1247.  
  1248.  
  1249.  
  1250.  
  1251.  
  1252.  
  1253.  
  1254.  
  1255.  
  1256.  
  1257.  
  1258.  
  1259.  
  1260.  
  1261.  
  1262.  
  1263.  
  1264.  
  1265.                                   TOOLBOX REFERENCE
  1266.  
  1267.  
  1268.  
  1269.  
  1270.  
  1271.  
  1272.  
  1273.  
  1274.  
  1275.  
  1276.  
  1277.  
  1278.  
  1279.  
  1280.  
  1281.  
  1282.  
  1283.  
  1284.  
  1285.  
  1286.  
  1287.  
  1288.  
  1289.  
  1290.  
  1291.         =====================================================================
  1292.         Copyright 1992 by Cyberphilia, Inc.                         Page [15]
  1293.  
  1294.  
  1295.  
  1296.  
  1297.  
  1298.  
  1299.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1300.         =====================================================================
  1301.  
  1302.         RtxClose [Subprogram]
  1303.  
  1304.         Syntax:   RtxClose Copies%, Retain%
  1305.  
  1306.                   Terminates  processing  of the  current  report, optionally
  1307.                   printing report to printer defined with RtxSetPrinter.
  1308.  
  1309.                   Parameter      Type/Description
  1310.                   -------------  -----------------------------------------
  1311.                   Copies         Integer; Number of copies to print
  1312.                                  0 ..... Do not print
  1313.                                  >0 .... Print specified number of copies
  1314.  
  1315.                   Retain         Integer;  Boolean  TRUE (-1)  or  FALSE (0);
  1316.                                  Indicates whether  report image  file should
  1317.                                  be retained after printing.
  1318.  
  1319.  
  1320.         Notes:    RtxResult returns one of the following values:
  1321.  
  1322.                   RTXSUCCESS%    Operation completed successfully
  1323.  
  1324.                   RTXUNKNOWN%    An unknown  error occurred  while performing
  1325.                                  operation
  1326.  
  1327.                   RTXBADCOPIES%  Invalid number of copies (< 0)
  1328.  
  1329.                   RTXNOTOPEN%    Report image has not yet been opened
  1330.  
  1331.                   RTXOUTOFPAPER% Printer is out of paper.
  1332.  
  1333.                   RTXNOTONLINE%  Printer is not online.
  1334.  
  1335.                   RTXIOERROR%    Printer I/O error occurred.
  1336.  
  1337.                   RTXTIMEOUT%    Printer timed out.
  1338.  
  1339.                   When   printing,  recoverable  errors  can  be  handled  by
  1340.                   interactive  screen displays  allowing  operator to  resume
  1341.                   printing when  condition is  rectified (Paper jam,  printer
  1342.                   out of paper, etc.) under Rtx's control.
  1343.  
  1344.                   If Rtx  is not handling  print errors, an RtxResult  of 3-6
  1345.                   indicates  the condition  and  that  printing was  canceled
  1346.                   automatically.  If it is, RtxResult 3-6 is only returned if
  1347.                   the  conditions occurred  and the  operator  then opted  to
  1348.                   discontinue printing.
  1349.  
  1350.  
  1351.         =====================================================================
  1352.         Copyright 1992 by Cyberphilia, Inc.                         Page [16]
  1353.  
  1354.  
  1355.  
  1356.  
  1357.  
  1358.  
  1359.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1360.         =====================================================================
  1361.  
  1362.         RtxData [Subprogram]
  1363.  
  1364.         Syntax:   RtxData Column%, Contents$
  1365.  
  1366.                   Inserts  contents of  specified  column  into  the  current
  1367.                   report row.
  1368.  
  1369.                   Parameter      Type/Description
  1370.                   -------------  -----------------------------------------
  1371.                   Column         Integer  in range 1 to the number of columns
  1372.                                  defined  with  RtxSetColumn;  Indicates  the
  1373.                                  report  column   in  which  to   insert  the
  1374.                                  associated contents.
  1375.  
  1376.                   Contents       String;  Contents to  insert into  specified
  1377.                                  column;  String format  varies depending  on
  1378.                                  column type as follows:
  1379.  
  1380.                                  STRING (Type 1) ... String
  1381.                                  INTEGER (Type 2) .. Mki$(Value%)
  1382.                                  LONG (Type 3) ..... Mkl$(Value&)
  1383.                                  SINGLE (Type 4) ... Mks$(Value!)
  1384.                                  DOUBLE (Type 5) ... Mkd$(Value#)
  1385.                                  CURRENCY (Type 6) . Mkc$(Value@)
  1386.  
  1387.         Notes:    RtxData requires that Contents  be supplied as a  string in
  1388.                   order to  provide one,  consistent interface  for all  data
  1389.                   types.
  1390.  
  1391.                   RtxResult returns one of the following values:
  1392.  
  1393.                   RTXSUCCESS%         Operation completed successfully
  1394.  
  1395.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  1396.                                       performing operation
  1397.  
  1398.                   RTXBADCOLUMN%       Column  is out of range (1 to number of
  1399.                                       columns defined with RtxSetColumn)
  1400.  
  1401.                   RTXBADCONTENTS%     Contents  are  invalid   (i.e.  Type  3
  1402.                                       column, LONG value, was not passed as a
  1403.                                       4-byte Mkl$() string.)
  1404.  
  1405.                   RTXNOTOPEN%         Report  image  file  has  not yet  been
  1406.                                       opened
  1407.  
  1408.  
  1409.  
  1410.  
  1411.         =====================================================================
  1412.         Copyright 1992 by Cyberphilia, Inc.                         Page [17]
  1413.  
  1414.  
  1415.  
  1416.  
  1417.  
  1418.  
  1419.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1420.         =====================================================================
  1421.  
  1422.         RtxGetBreak [Function]
  1423.  
  1424.         Syntax:   x = RtxGetBreak
  1425.  
  1426.                   Returns the  break number,  if  any, that  has either  just
  1427.                   occurred or is about to occur.
  1428.  
  1429.  
  1430.         Notes:    RtxResult returns one of the following values:
  1431.  
  1432.                   RTXSUCCESS%    Operation completed successfully
  1433.  
  1434.                   RTXUNKNOWN%    An unknown  error occurred  while performing
  1435.                                  operation
  1436.  
  1437.                   RTXNOTOPEN%    Report image file has not yet been opened
  1438.  
  1439.                   RtxGetBreak() called immediately prior to RtxOutput returns
  1440.                   the break that will occur once RtxOutput is called.  If  no
  1441.                   break   is  about  to   occur,  RtxGetBreak()   returns  0.
  1442.                   RtxGetBreak() called immediately after an RtxOutput returns
  1443.                   the break  number that  has just  occurred.   RtxGetBreak()
  1444.                   returns 0 if no break has occurred.
  1445.  
  1446.  
  1447.  
  1448.  
  1449.  
  1450.  
  1451.  
  1452.  
  1453.  
  1454.  
  1455.  
  1456.  
  1457.  
  1458.  
  1459.  
  1460.  
  1461.  
  1462.  
  1463.  
  1464.  
  1465.  
  1466.  
  1467.  
  1468.  
  1469.  
  1470.  
  1471.         =====================================================================
  1472.         Copyright 1992 by Cyberphilia, Inc.                         Page [18]
  1473.  
  1474.  
  1475.  
  1476.  
  1477.  
  1478.  
  1479.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1480.         =====================================================================
  1481. ==
  1482.         RtxGetPage [Function]
  1483.  
  1484.         Syntax:   x = RtxGetPage
  1485.  
  1486.                   Returns the current page number.
  1487.  
  1488.  
  1489.         Notes:    RtxResult returns one of the following values:
  1490.  
  1491.                   RTXSUCCESS%    Operation completed successfully
  1492.  
  1493.                   RTXUNKNOWN%    An unknown  error occurred  while performing
  1494.                                  operation
  1495.  
  1496.                   RTXNOTOPEN%    Report image file has not yet been opened
  1497.  
  1498.  
  1499.  
  1500.  
  1501.  
  1502.  
  1503.  
  1504.  
  1505.  
  1506.  
  1507.  
  1508.  
  1509.  
  1510.  
  1511.  
  1512.  
  1513.  
  1514.  
  1515.  
  1516.  
  1517.  
  1518.  
  1519.  
  1520.  
  1521.  
  1522.  
  1523.  
  1524.  
  1525.  
  1526.  
  1527.  
  1528.  
  1529.  
  1530.  
  1531.         =====================================================================
  1532.         Copyright 1992 by Cyberphilia, Inc.                         Page [19]
  1533.  
  1534.  
  1535.  
  1536.  
  1537.  
  1538.  
  1539.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1540.         =====================================================================
  1541.  
  1542.         RtxGetRemaining [Function]
  1543.  
  1544.         Syntax:   x = RtxGetRemaining
  1545.  
  1546.                   Returns  the number  of printable  lines  remaining on  the
  1547.                   current page.
  1548.  
  1549.  
  1550.         Notes:    RtxResult returns one of the following values:
  1551.  
  1552.                   RTXSUCCESS%    Operation completed successfully
  1553.  
  1554.                   RTXUNKNOWN%    An unknown  error occurred  while performing
  1555.                                  operation
  1556.  
  1557.                   RTXNOTOPEN%    Report image file has not yet been opened
  1558.  
  1559.  
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.  
  1566.  
  1567.  
  1568.  
  1569.  
  1570.  
  1571.  
  1572.  
  1573.  
  1574.  
  1575.  
  1576.  
  1577.  
  1578.  
  1579.  
  1580.  
  1581.  
  1582.  
  1583.  
  1584.  
  1585.  
  1586.  
  1587.  
  1588.  
  1589.  
  1590.  
  1591.         =====================================================================
  1592.         Copyright 1992 by Cyberphilia, Inc.                         Page [20]
  1593.  
  1594.  
  1595.  
  1596.  
  1597.  
  1598.  
  1599.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1600.         =====================================================================
  1601.  
  1602.         RtxInit [Subprogram]
  1603.  
  1604.         Syntax:   RtxInit
  1605.  
  1606.                   Initializes Rtx system to begin processing a new report.
  1607.  
  1608.  
  1609.         Notes:    Always returns an RtxResult of RTXSUCCESS%
  1610.  
  1611.  
  1612.  
  1613.  
  1614.  
  1615.  
  1616.  
  1617.  
  1618.  
  1619.  
  1620.  
  1621.  
  1622.  
  1623.  
  1624.  
  1625.  
  1626.  
  1627.  
  1628.  
  1629.  
  1630.  
  1631.  
  1632.  
  1633.  
  1634.  
  1635.  
  1636.  
  1637.  
  1638.  
  1639.  
  1640.  
  1641.  
  1642.  
  1643.  
  1644.  
  1645.  
  1646.  
  1647.  
  1648.  
  1649.  
  1650.  
  1651.         =====================================================================
  1652.         Copyright 1992 by Cyberphilia, Inc.                         Page [21]
  1653.  
  1654.  
  1655.  
  1656.  
  1657.  
  1658.  
  1659.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1660.         =====================================================================
  1661.  
  1662.         RtxNewPage [Subprogram]
  1663.  
  1664.         Syntax:   RtxNewPage
  1665.  
  1666.                   Forces printing to continue at the top of a new page.
  1667.  
  1668.  
  1669.         Notes:    RtxResult returns one of the following values:
  1670.  
  1671.                   RTXSUCCESS%    Operation completed successfully
  1672.  
  1673.                   RTXUNKNOWN%    An unknown  error occurred  while performing
  1674.                                  operation
  1675.  
  1676.                   RTXNOTOPEN%    Report image file has not yet been opened
  1677.  
  1678.  
  1679.  
  1680.  
  1681.  
  1682.  
  1683.  
  1684.  
  1685.  
  1686.  
  1687.  
  1688.  
  1689.  
  1690.  
  1691.  
  1692.  
  1693.  
  1694.  
  1695.  
  1696.  
  1697.  
  1698.  
  1699.  
  1700.  
  1701.  
  1702.  
  1703.  
  1704.  
  1705.  
  1706.  
  1707.  
  1708.  
  1709.  
  1710.  
  1711.         =====================================================================
  1712.         Copyright 1992 by Cyberphilia, Inc.                         Page [22]
  1713.  
  1714.  
  1715.  
  1716.  
  1717.  
  1718.  
  1719.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1720.         =====================================================================
  1721.  
  1722.         RtxOpen [Subprogram]
  1723.  
  1724.         Syntax:   RtxOpen FileSpec$, Overwrite%
  1725.  
  1726.                   Opens the report image file for processing.
  1727.  
  1728.                   Parameter      Type/Description
  1729.                   -------------  -----------------------------------------
  1730.                   FileSpec       String;  Fully-qualified  MS-DOS  file name,
  1731.                                  including path  (if necessary), of  the file
  1732.                                  to receive the report image.
  1733.  
  1734.                   Overwrite      Integer; Boolean TRUE (-1) or FALSE  (0); If
  1735.                                  TRUE and  FileSpec already  exists on  disk,
  1736.                                  Rtx deletes the old copy before opening  the
  1737.                                  new file.
  1738.  
  1739.  
  1740.         Notes:    RtxResult returns one of the following values:
  1741.  
  1742.                   RTXSUCCESS%         Operation completed successfully
  1743.  
  1744.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  1745.                                       performing operation
  1746.  
  1747.                   RTXBADFILENAME%     FileSpec  is  not a  valid  MS-DOS file
  1748.                                       name.
  1749.  
  1750.                   RTXFILEEXISTS%      FileSpec exists but Overwrite is FALSE.
  1751.  
  1752.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  1753.                                       opened
  1754.  
  1755.  
  1756.  
  1757.  
  1758.  
  1759.  
  1760.  
  1761.  
  1762.  
  1763.  
  1764.  
  1765.  
  1766.  
  1767.  
  1768.  
  1769.  
  1770.  
  1771.         =====================================================================
  1772.         Copyright 1992 by Cyberphilia, Inc.                         Page [23]
  1773.  
  1774.  
  1775.  
  1776.  
  1777.  
  1778.  
  1779.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1780.         =====================================================================
  1781.  
  1782.         RtxOutput [Subprogram]
  1783.  
  1784.         Syntax:   RtxOutput
  1785.  
  1786.                   Outputs current report row to report image file.
  1787.  
  1788.  
  1789.         Notes:    RtxOutput must be called each time a row has been filled by
  1790.                   calls to RtxData and is  ready to write to the  image file.
  1791.                   RtxOutput then clears out buffers for the next row.
  1792.  
  1793.                   RtxResult returns one of the following values:
  1794.  
  1795.                   RTXSUCCESS%    Operation completed successfully
  1796.  
  1797.                   RTXUNKNOWN%    An unknown  error occurred  while performing
  1798.                                  operation
  1799.  
  1800.                   RTXNOTOPEN%    Report image has not yet been opened
  1801.  
  1802.  
  1803.  
  1804.  
  1805.  
  1806.  
  1807.  
  1808.  
  1809.  
  1810.  
  1811.  
  1812.  
  1813.  
  1814.  
  1815.  
  1816.  
  1817.  
  1818.  
  1819.  
  1820.  
  1821.  
  1822.  
  1823.  
  1824.  
  1825.  
  1826.  
  1827.  
  1828.  
  1829.  
  1830.  
  1831.         =====================================================================
  1832.         Copyright 1992 by Cyberphilia, Inc.                         Page [24]
  1833.  
  1834.  
  1835.  
  1836.  
  1837.  
  1838.  
  1839.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1840.         =====================================================================
  1841.  
  1842.         RtxResult [Function]
  1843.  
  1844.         Syntax:   x = RtxResult
  1845.  
  1846.                   Returns the procedure specific result of the last Rtx call.
  1847.  
  1848.  
  1849.         Notes:    See Appendix A for a list of all known result codes.
  1850.  
  1851.  
  1852.  
  1853.  
  1854.  
  1855.  
  1856.  
  1857.  
  1858.  
  1859.  
  1860.  
  1861.  
  1862.  
  1863.  
  1864.  
  1865.  
  1866.  
  1867.  
  1868.  
  1869.  
  1870.  
  1871.  
  1872.  
  1873.  
  1874.  
  1875.  
  1876.  
  1877.  
  1878.  
  1879.  
  1880.  
  1881.  
  1882.  
  1883.  
  1884.  
  1885.  
  1886.  
  1887.  
  1888.  
  1889.  
  1890.  
  1891.         =====================================================================
  1892.         Copyright 1992 by Cyberphilia, Inc.                         Page [25]
  1893.  
  1894.  
  1895.  
  1896.  
  1897.  
  1898.  
  1899.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1900.         =====================================================================
  1901.  
  1902.         RtxSetBreak [Subprogram]
  1903.  
  1904.         Syntax:   RtxSetBreak Number%, Column%, Skip%, Text$
  1905.  
  1906.                   Establishes  a "break"  in  the  report,  that is,  when  a
  1907.                   logical break in the report occurs.
  1908.  
  1909.                   Parameter      Type/Description
  1910.                   -------------  -----------------------------------------
  1911.                   Number         Integer  in  the range  1  to 5,  specifying
  1912.                                  which break is being declared.
  1913.  
  1914.                   Column         Integer in  range  1 to  number  of  columns
  1915.                                  defined with  RtxSetColumn; Column  in which
  1916.                                  to look for a break.
  1917.  
  1918.                   Skip           Integer;  the number  of blank rows  to skip
  1919.                                  after  processing   the  break   but  before
  1920.                                  printing the next  row.  Can also be  set to
  1921.                                  (-1) to jump to the beginning of a new page.
  1922.  
  1923.                   Text           String;  Text to  print  immediately to  the
  1924.                                  left of the first totalling column.
  1925.  
  1926.  
  1927.         Notes:    Rtx allows up to 5 explicit breaks within each report.
  1928.  
  1929.                   RtxResult returns one of the following values:
  1930.  
  1931.                   RTXSUCCESS%         Operation completed successfully
  1932.  
  1933.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  1934.                                       performing operation
  1935.  
  1936.                   RTXBADBREAK%        Number is out of range (1 to 5)
  1937.  
  1938.                   RTXBADCOLUMN%       Column  is out of range (1 to number of
  1939.                                       columns declared with RtxSetColumn)
  1940.  
  1941.                   RTXBADSKIP%         Invalid  number of  rows to  skip after
  1942.                                       processing break (< -1)
  1943.  
  1944.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  1945.                                       opened
  1946.  
  1947.  
  1948.  
  1949.  
  1950.  
  1951.         =====================================================================
  1952.         Copyright 1992 by Cyberphilia, Inc.                         Page [26]
  1953.  
  1954.  
  1955.  
  1956.  
  1957.  
  1958.  
  1959.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  1960.         =====================================================================
  1961.  
  1962.         RtxSetBreak0 [Subprogram]
  1963.  
  1964.         Syntax:   RtxSetBreak0 Text$
  1965.  
  1966.                   Establishes text to  print immediately to  the left of  the
  1967.                   first totalling column at the end of a report.
  1968.  
  1969.                   Parameter      Type/Description
  1970.                   -------------  -----------------------------------------
  1971.                   Text           String;  Text to  print  immediately to  the
  1972.                                  left of the first totalling column.
  1973.  
  1974.  
  1975.         Notes:    Break  '0'  is always  processed  by Rtx  when  RtxClose is
  1976.                   called  just prior  to actually  closing  the report  image
  1977.                   file.  It is a special break that exists to flush out final
  1978.                   report totals.
  1979.  
  1980.                   RtxResult returns one of the following values:
  1981.  
  1982.                   RTXSUCCESS%         Operation completed successfully
  1983.  
  1984.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  1985.                                       performing operation
  1986.  
  1987.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  1988.                                       opened
  1989.  
  1990.  
  1991.  
  1992.  
  1993.  
  1994.  
  1995.  
  1996.  
  1997.  
  1998.  
  1999.  
  2000.  
  2001.  
  2002.  
  2003.  
  2004.  
  2005.  
  2006.  
  2007.  
  2008.  
  2009.  
  2010.  
  2011.         =====================================================================
  2012.         Copyright 1992 by Cyberphilia, Inc.                         Page [27]
  2013.  
  2014.  
  2015.  
  2016.  
  2017.  
  2018.  
  2019.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2020.         =====================================================================
  2021.  
  2022.         RtxSetColumn [Subprogram]
  2023.  
  2024.         Syntax:   RtxSetColumn  Column%, Label$,  Source%,  Mask$, Style%,  _
  2025.                   Total%, First%
  2026.  
  2027.                   Declares the characteristics of a report column.
  2028.  
  2029.                   Parameter      Type/Description
  2030.                   -------------  -----------------------------------------
  2031.                   Column         Integer in  range  1  to  10;  Column  being
  2032.                                  declared.
  2033.  
  2034.                   Label          String; Text to be used as column heading.
  2035.  
  2036.                   Source         Integer; Type of source data to be passed by
  2037.                                  subsequent RtxData calls as follows:
  2038.  
  2039.                                  1 ... STRING
  2040.                                  2 ... INTEGER
  2041.                                  3 ... LONG
  2042.                                  4 ... SINGLE
  2043.                                  5 ... DOUBLE
  2044.                                  6 ... CURRENCY
  2045.  
  2046.                   Mask           String; Mask used to describe  length of the
  2047.                                  column and format of resulting output.
  2048.  
  2049.                   Style          Integer;    Specifies    justification    of
  2050.                                  formatted data within the column as follows:
  2051.  
  2052.                                  0 ....... Flush left
  2053.                                  1 ....... Flush right
  2054.                                  2 ....... Centered
  2055.  
  2056.                   Total          Integer;  Boolean  TRUE  (-1)  or  FALSE(0);
  2057.                                  Indicates that a total for this column is to
  2058.                                  be  printed   when  breaks   specified  with
  2059.                                  RtxSetBreak occur.
  2060.  
  2061.                   First          Integer;  Boolean  TRUE  (-1)  or  FALSE(0);
  2062.                                  Indicates that only the  first occurrence of
  2063.                                  the column's contents are to be printed when
  2064.                                  two or  more rows contain  exactly the  same
  2065.                                  contents, producing a hanging indent.
  2066.  
  2067.  
  2068.  
  2069.  
  2070.  
  2071.         =====================================================================
  2072.         Copyright 1992 by Cyberphilia, Inc.                         Page [28]
  2073.  
  2074.  
  2075.  
  2076.  
  2077.  
  2078.  
  2079.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2080.         =====================================================================
  2081.  
  2082.         Notes:    Rtx makes calls  to PDS's Format Add-on library  using your
  2083.                   mask.   You must  link your  programs with the  DTFMTER.LIB
  2084.                   library supplied with your copy  of PDS for Rtx to function
  2085.                   properly.    Please   see  PDS's  documentation  for   more
  2086.                   information on specifying masks.
  2087.  
  2088.  
  2089.                   Source types are declared  as constants in RTX.BI  for your
  2090.                   convenience as follows:
  2091.  
  2092.                   RTXSTRING%, RTXINTEGER%, RTXLONG%,  RTXSINGLE%, RTXDOUBLE%,
  2093.                   RTXCURRENCY%
  2094.  
  2095.  
  2096.                   Style   types  are  also   declared  in  RTX.BI   for  your
  2097.                   convenience:
  2098.  
  2099.                   RTXLEFT%, RTXRIGHT%, RTXCENTER%
  2100.  
  2101.  
  2102.                   RtxResult returns one of the following values:
  2103.  
  2104.                   RTXSUCCESS%         Operation completed successfully
  2105.  
  2106.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  2107.                                       performing operation
  2108.  
  2109.                   RTXBADCOLUMN%       Invalid column (< 1 or > 10)
  2110.  
  2111.                   RTXBADSOURCE%       Invalid source type (< 1 or > 6)
  2112.  
  2113.                   RTXBADMASK%         Invalid or no mask specified
  2114.  
  2115.                   RTXBADSTYLE%        Invalid style (< 0 or > 2)
  2116.  
  2117.                   RTXBADTOTAL%        Columns  with  string  data  cannot  be
  2118.                                       totalled.
  2119.  
  2120.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  2121.                                       opened
  2122.  
  2123.  
  2124.  
  2125.  
  2126.  
  2127.  
  2128.  
  2129.  
  2130.  
  2131.         =====================================================================
  2132.         Copyright 1992 by Cyberphilia, Inc.                         Page [29]
  2133.  
  2134.  
  2135.  
  2136.  
  2137.  
  2138.  
  2139.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2140.         =====================================================================
  2141.  
  2142.         RtxSetError [Subprogram]
  2143.  
  2144.         Syntax:   RtxSetError Row%
  2145.  
  2146.                   Parameter      Type/Description
  2147.                   -------------  -----------------------------------------
  2148.                   Row            Integer; Screen  row to use  when displaying
  2149.                                  interactive  printer   error  messages   and
  2150.                                  prompts or  0 to  disable interactive  error
  2151.                                  handling.
  2152.  
  2153.  
  2154.         Notes:    RtxResult returns one of the following values:
  2155.  
  2156.                   RTXSUCCESS%         Operation completed successfully
  2157.  
  2158.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  2159.                                       performing operation
  2160.  
  2161.                   RTXBADROW%          Invalid  row (< 0  or >  current screen
  2162.                                       length)
  2163.  
  2164.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  2165.                                       opened
  2166.  
  2167.  
  2168.  
  2169.  
  2170.  
  2171.  
  2172.  
  2173.  
  2174.  
  2175.  
  2176.  
  2177.  
  2178.  
  2179.  
  2180.  
  2181.  
  2182.  
  2183.  
  2184.  
  2185.  
  2186.  
  2187.  
  2188.  
  2189.  
  2190.  
  2191.         =====================================================================
  2192.         Copyright 1992 by Cyberphilia, Inc.                         Page [30]
  2193.  
  2194.  
  2195.  
  2196.  
  2197.  
  2198.  
  2199.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2200.         =====================================================================
  2201.  
  2202.         RtxSetFooting [Subprogram]
  2203.  
  2204.         Syntax:   RtxSetFooting Number%, Text$, Style%
  2205.  
  2206.                   Declares a row of footer text.
  2207.  
  2208.                   Parameter      Type/Description
  2209.                   -------------  -----------------------------------------
  2210.                   Number         Integer in range  1 to 5; Report  footer row
  2211.                                  being declared as 1 to 5, from top to bottom
  2212.                                  of footer area.
  2213.  
  2214.                   Text           String; Text to be printed in specified row.
  2215.  
  2216.                   Style          Integer;  Specifies  justification   of  the
  2217.                                  footer text within the row as follows:
  2218.  
  2219.                                  0 ....... Flush left
  2220.                                  1 ....... Flush right
  2221.                                  2 ....... Centered
  2222.  
  2223.  
  2224.         Notes:    RtxResult returns one of the following values:
  2225.  
  2226.                   RTXSUCCESS%         Operation completed successfully
  2227.  
  2228.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  2229.                                       performing operation
  2230.  
  2231.                   RTXBADFOOTER%       Invalid footer number (< 1 or > 5)
  2232.  
  2233.                   RTXBADSTYLE%        Invalid style (< 0 or > 2)
  2234.  
  2235.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  2236.                                       opened
  2237.  
  2238.                   Specifying Text as  either a single hyphen (-)  or a single
  2239.                   equal sign  (=) causes Rtx  to fill  the row across  with a
  2240.                   line composed of the respective character.
  2241.  
  2242.  
  2243.  
  2244.  
  2245.  
  2246.  
  2247.  
  2248.  
  2249.  
  2250.  
  2251.         =====================================================================
  2252.         Copyright 1992 by Cyberphilia, Inc.                         Page [31]
  2253.  
  2254.  
  2255.  
  2256.  
  2257.  
  2258.  
  2259.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2260.         =====================================================================
  2261.  
  2262.         RtxSetForm [Subprogram]
  2263.  
  2264.         Syntax:   RtxSetForm   FormWidth%,   FormLength%,    LeftMargin%,   _
  2265.                   TopMargin%, BottomMargin%
  2266.  
  2267.                   Defines overall form characteristics.
  2268.  
  2269.                   Parameter      Type/Description
  2270.                   -------------  -----------------------------------------
  2271.                   FormWidth      Integer in range  1 to 255; Total  number of
  2272.                                  printable characters across the page.
  2273.  
  2274.                   FormLength     Integer in range  1 to 255; Total  number of
  2275.                                  printable lines down the page.
  2276.  
  2277.                   LeftMargin     Integer  in range 0 to width of form; Number
  2278.                                  of characters  to skip  on  the left  before
  2279.                                  printing data.
  2280.  
  2281.                   TopMargin      Integer in range 0 to length of form; Number
  2282.                                  of lines  to  skip  before  printing  report
  2283.                                  header.
  2284.  
  2285.                   BottomMargin   Integer in range 0 to length of form; Number
  2286.                                  of  lines  to  skip  after  printing  report
  2287.                                  footer before new page.
  2288.  
  2289.  
  2290.         Notes:    RtxResult returns one of the following values:
  2291.  
  2292.                   RTXSUCCESS%         Operation completed successfully
  2293.  
  2294.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  2295.                                       performing operation
  2296.  
  2297.                   RTXBADWIDTH%        Invalid form width (< 1 or > 255)
  2298.  
  2299.                   RTXBADLENGTH%       Invalid form length (< 1 or > 255)
  2300.  
  2301.                   RTXBADLEFT%         Invalid   left  margin   (<   0  or   >
  2302.                                       FormWidth)
  2303.  
  2304.                   RTXBADTOP%          Invalid top margin (0 or > FormLength)
  2305.  
  2306.                   RTXBADBOTTOM%       Invalid  bottom   margin  (<  0   or  >
  2307.                                       FormLength)
  2308.  
  2309.  
  2310.  
  2311.         =====================================================================
  2312.         Copyright 1992 by Cyberphilia, Inc.                         Page [32]
  2313.  
  2314.  
  2315.  
  2316.  
  2317.  
  2318.  
  2319.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2320.         =====================================================================
  2321.  
  2322.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  2323.                                       opened
  2324.  
  2325.  
  2326.  
  2327.  
  2328.  
  2329.  
  2330.  
  2331.  
  2332.  
  2333.  
  2334.  
  2335.  
  2336.  
  2337.  
  2338.  
  2339.  
  2340.  
  2341.  
  2342.  
  2343.  
  2344.  
  2345.  
  2346.  
  2347.  
  2348.  
  2349.  
  2350.  
  2351.  
  2352.  
  2353.  
  2354.  
  2355.  
  2356.  
  2357.  
  2358.  
  2359.  
  2360.  
  2361.  
  2362.  
  2363.  
  2364.  
  2365.  
  2366.  
  2367.  
  2368.  
  2369.  
  2370.  
  2371.         =====================================================================
  2372.         Copyright 1992 by Cyberphilia, Inc.                         Page [33]
  2373.  
  2374.  
  2375.  
  2376.  
  2377.  
  2378.  
  2379.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2380.         =====================================================================
  2381.  
  2382.         RtxSetHeading [Subprogram]
  2383.  
  2384.         Syntax:   RtxSetHeading Number%, Text$, Style%
  2385.  
  2386.                   Declares a row of heading text.
  2387.  
  2388.                   Parameter      Type/Description
  2389.                   -------------  -----------------------------------------
  2390.                   Number         Integer in range  1 to 5; Report  header row
  2391.                                  being declared as 1 to 5, from top to bottom
  2392.                                  of header area.
  2393.  
  2394.                   Text           String; Text to be printed in specified row.
  2395.  
  2396.                   Style          Integer;  Specifies  justification   of  the
  2397.                                  header text within the row as follows:
  2398.  
  2399.                                  0 ....... Flush left
  2400.                                  1 ....... Flush right
  2401.                                  2 ....... Centered
  2402.  
  2403.  
  2404.         Notes:    RtxResult returns one of the following values:
  2405.  
  2406.                   RTXSUCCESS%         Operation completed successfully
  2407.  
  2408.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  2409.                                       performing operation
  2410.  
  2411.                   RTXBADHEADER%       Invalid header number (< 1 or > 5)
  2412.  
  2413.                   RTXBADSTYLE%        Invalid style (< 0 or > 2)
  2414.  
  2415.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  2416.                                       opened
  2417.  
  2418.                   Specifying Text as  either a single hyphen (-)  or a single
  2419.                   equal sign  (=) causes Rtx  to fill  the row across  with a
  2420.                   line composed of the respective character.
  2421.  
  2422.  
  2423.  
  2424.  
  2425.  
  2426.  
  2427.  
  2428.  
  2429.  
  2430.  
  2431.         =====================================================================
  2432.         Copyright 1992 by Cyberphilia, Inc.                         Page [34]
  2433.  
  2434.  
  2435.  
  2436.  
  2437.  
  2438.  
  2439.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2440.         =====================================================================
  2441.  
  2442.         RtxSetPrinter [Subprogram]
  2443.  
  2444.         Syntax:   RtxSetPrinter Number%
  2445.  
  2446.                   Specifies the printer to be used when printing reports.
  2447.  
  2448.                   Parameter      Type/Description
  2449.                   -------------  -----------------------------------------
  2450.                   Number         Integer in range 1 to 3 (i.e. LPT1 to LPT3).
  2451.  
  2452.  
  2453.         Notes:    RtxResult returns one of the following values:
  2454.  
  2455.                   RTXSUCCESS%         Operation completed successfully
  2456.  
  2457.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  2458.                                       performing operation
  2459.  
  2460.                   RTXBADPRINTER%      Invalid printer number (< 1 or > 3)
  2461.  
  2462.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  2463.                                       opened
  2464.  
  2465.  
  2466.  
  2467.  
  2468.  
  2469.  
  2470.  
  2471.  
  2472.  
  2473.  
  2474.  
  2475.  
  2476.  
  2477.  
  2478.  
  2479.  
  2480.  
  2481.  
  2482.  
  2483.  
  2484.  
  2485.  
  2486.  
  2487.  
  2488.  
  2489.  
  2490.  
  2491.         =====================================================================
  2492.         Copyright 1992 by Cyberphilia, Inc.                         Page [35]
  2493.  
  2494.  
  2495.  
  2496.  
  2497.  
  2498.  
  2499.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2500.         =====================================================================
  2501.  
  2502.         RtxSkip [Subprogram]
  2503.  
  2504.         Syntax:   RtxSkip Rows%
  2505.  
  2506.                   Skip specified number  of rows (output  blank rows) in  the
  2507.                   report image or skip to the top of a new page.
  2508.  
  2509.                   Parameter      Type/Description
  2510.                   -------------  -----------------------------------------
  2511.                   Rows           Integer; in range -1 to form length
  2512.  
  2513.  
  2514.         Notes:    RtxResult returns one of the following values:
  2515.  
  2516.                   RTXSUCCESS%    Operation completed successfully
  2517.  
  2518.                   RTXUNKNOWN%    An unknown  error occurred  while performing
  2519.                                  operation
  2520.  
  2521.                   RTXBADSKIP%    Invalid  number   of   rows  (<   -1  or   >
  2522.                                  FormLength)
  2523.  
  2524.                   RTXNOTOPEN%    Report image has not yet been opened
  2525.  
  2526.                   RtxSkip skips  the specified number  of lines or  until the
  2527.                   bottom of the page is reached, whichever occurs first.
  2528.  
  2529.  
  2530.  
  2531.  
  2532.  
  2533.  
  2534.  
  2535.  
  2536.  
  2537.  
  2538.  
  2539.  
  2540.  
  2541.  
  2542.  
  2543.  
  2544.  
  2545.  
  2546.  
  2547.  
  2548.  
  2549.  
  2550.  
  2551.         =====================================================================
  2552.         Copyright 1992 by Cyberphilia, Inc.                         Page [36]
  2553.  
  2554.  
  2555.  
  2556.  
  2557.  
  2558.  
  2559.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2560.         =====================================================================
  2561.  
  2562.         RtxSuppress [Subprogram]
  2563.  
  2564.         Syntax:   RtxSuppress State%
  2565.  
  2566.                   Turns suppression of single-item block subtotals on/off.
  2567.  
  2568.                   Parameter      Type/Description
  2569.                   -------------  -----------------------------------------
  2570.                   State          Integer; Boolean TRUE (-1) or FALSE(0); Sets
  2571.                                  new  state  of  single-item  block  subtotal
  2572.                                  suppression.
  2573.  
  2574.  
  2575.         Notes:    RtxResult returns one of the following values:
  2576.  
  2577.                   RTXSUCCESS%         Operation completed successfully
  2578.  
  2579.                   RTXUNKNOWN%         An   unknown   error   occurred   while
  2580.                                       performing operation
  2581.  
  2582.                   RTXALREADYOPEN%     Report  image  file  has  already  been
  2583.                                       opened
  2584.  
  2585.                   Single-item blocks occur when one break immediately follows
  2586.                   another,  resulting in  only  one  item  appearing  on  the
  2587.                   printed page between  subtotals.  Rtx's normal  behavior is
  2588.                   to subtotal at  every declared break.   Turning suppression
  2589.                   on   causes  Rtx   not  to   subtotal  single-item   blocks
  2590.                   unnecessarily, for example:
  2591.  
  2592.                   ========================================================
  2593.  
  2594.                   RtxSuppress       10/01/91  1234  1001   20450    100.00
  2595.                   False                                            -------
  2596.                                                       DATE TOTALS   100.00
  2597.  
  2598.                   --------------------------------------------------------
  2599.  
  2600.                   RtxSuppress       10/01/91  1234  1001   20450    100.00
  2601.                   True
  2602.  
  2603.                   ========================================================
  2604.  
  2605.                   The most commonly found single-item block  is when only one
  2606.                   line appears in  a block as in the  above example. However,
  2607.                   they   also  occur  between   nested  breaks  and   do  not
  2608.                   necessarily consist of only one line, for example:
  2609.  
  2610.  
  2611.         =====================================================================
  2612.         Copyright 1992 by Cyberphilia, Inc.                         Page [37]
  2613.  
  2614.  
  2615.  
  2616.  
  2617.  
  2618.  
  2619.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2620.         =====================================================================
  2621.  
  2622.                   ========================================================
  2623.  
  2624.                   RtxSuppress       10/01/91  1234  1001   20450    100.00
  2625.                   False                                          ---------
  2626.                                                     PAYEE TOTALS    100.00
  2627.  
  2628.                                               1235  1002   20451    150.00
  2629.  
  2630.                                                                  ---------
  2631.                                                     PAYEE TOTALS    150.00
  2632.  
  2633.                                               1401  1003   20452    125.00
  2634.                                                     1004   20450    110.00
  2635.                                                                  ---------
  2636.                                                     PAYEE TOTALS    235.00
  2637.  
  2638.                                               1402  1005   20451    205.00
  2639.                                                                  ---------
  2640.                                                     PAYEE TOTALS    205.00
  2641.  
  2642.                                                                  ---------
  2643.                                                      DATE TOTALS    690.00
  2644.  
  2645.                                                                  ---------
  2646.                                                    REPORT TOTALS    690.00
  2647.  
  2648.                   --------------------------------------------------------
  2649.  
  2650.                   RtxSuppress       10/01/91  1234  1001   20450    100.00
  2651.                   True 
  2652.                                               1235  1002   20451    150.00
  2653.  
  2654.                                               1401  1003   20452    125.00
  2655.                                                     1004   20450    110.00
  2656.                                                                  ---------
  2657.                                                     PAYEE TOTALS    235.00
  2658.  
  2659.                                               1402  1005   20451    205.00
  2660.  
  2661.                                                                  ---------
  2662.                                                    REPORT TOTALS    690.00
  2663.  
  2664.                   ========================================================
  2665.  
  2666.                   Notice how when RtxSuppress is True, no date totals appear,
  2667.                   but  when  it's False  they  do.    Even though  the  block
  2668.                   consists of multiple  lines, they're all  of the same  date
  2669.                   and it's the  only date in the  report.  The  date subtotal
  2670.  
  2671.         =====================================================================
  2672.         Copyright 1992 by Cyberphilia, Inc.                         Page [38]
  2673.  
  2674.  
  2675.  
  2676.  
  2677.  
  2678.  
  2679.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2680.         =====================================================================
  2681.  
  2682.                   and the report total are  the same.  Turning RtxSuppress ON
  2683.                   (True) eliminates the unnecessary subtotalling of the date.
  2684.  
  2685.  
  2686.  
  2687.  
  2688.  
  2689.  
  2690.  
  2691.  
  2692.  
  2693.  
  2694.  
  2695.  
  2696.  
  2697.  
  2698.  
  2699.  
  2700.  
  2701.  
  2702.  
  2703.  
  2704.  
  2705.  
  2706.  
  2707.  
  2708.  
  2709.  
  2710.  
  2711.  
  2712.  
  2713.  
  2714.  
  2715.  
  2716.  
  2717.  
  2718.  
  2719.  
  2720.  
  2721.  
  2722.  
  2723.  
  2724.  
  2725.  
  2726.  
  2727.  
  2728.  
  2729.  
  2730.  
  2731.         =====================================================================
  2732.         Copyright 1992 by Cyberphilia, Inc.                         Page [39]
  2733.  
  2734.  
  2735.  
  2736.  
  2737.  
  2738.  
  2739.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2740.         =====================================================================
  2741.  
  2742.                               APPENDIX A - RESULT CODES
  2743.  
  2744.         The  following   list  details  all   result  codes  known   to  Rtx.
  2745.         Immediately following  each result code  is a list of  the conditions
  2746.         that occur which  would return such a  result code.  Please  be aware
  2747.         that the result codes within square brackets are defined as constants
  2748.         in RTX.BI.  Please use these constants instead of the value  you find
  2749.         for them in RTX.BI, as they may change from one version to the next.
  2750.  
  2751.  
  2752.         [RTXALREADYOPEN%] Report image file has already been opened
  2753.  
  2754.              RtxOpen has been called and either:
  2755.  
  2756.              1)   This  is the  first  report generated  in  the session  and
  2757.                   RtxInit has not been called.
  2758.  
  2759.              2)   Previously  generated   report  was  not   terminated  with
  2760.                   RtxClose.
  2761.  
  2762.              3)   Operation can only be performed prior to opening the report
  2763.                   image file.
  2764.  
  2765.  
  2766.         [RTXBADBOTTOM%] Invalid bottom margin
  2767.  
  2768.              Bottom margin specified  is out of range 0 to the length of form
  2769.              set with RtxSetForm.
  2770.  
  2771.  
  2772.         [RTXBADBREAK%] Break number specified is out of valid range
  2773.  
  2774.              1)   Break number supplied to RtxSetBreak is out of range 1..5.
  2775.  
  2776.              2)   Break number supplied elsewhere is out of range 0 to number
  2777.                   of breaks set with RtxSetBreak.
  2778.  
  2779.  
  2780.         [RTXBADCOLUMN%] Invalid column number
  2781.  
  2782.              1)   Column  number supplied  to RtxSetColumn  is  out of  range
  2783.                   1..10.
  2784.  
  2785.              2)   Column  number  supplied elsewhere  is  out of  range  1 to
  2786.                   number of columns declared with RtxSetColumn.
  2787.  
  2788.  
  2789.         [RTXBADCONTENTS%] Contents are invalid
  2790.  
  2791.         =====================================================================
  2792.         Copyright 1992 by Cyberphilia, Inc.                         Page [40]
  2793.  
  2794.  
  2795.  
  2796.  
  2797.  
  2798.  
  2799.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2800.         =====================================================================
  2801.  
  2802.              Contents  supplied to  RtxData for  the  column are  not in  the
  2803.              format expected  by Rtx,  dictated by  the column's source  data
  2804.              type set with RtxSetColumn.
  2805.  
  2806.  
  2807.         [RTXBADCOPIES%] Invalid number of copies
  2808.  
  2809.              Number of copies to print specified to RtxClose are out of range
  2810.              0..255.
  2811.  
  2812.  
  2813.         [RTXBADFILENAME%] FileSpec is not a valid MS-DOS file name
  2814.  
  2815.              File name supplied to  RtxOpen is not a valid  MS-DOS file name,
  2816.              contains an invalid path or is null.
  2817.  
  2818.  
  2819.         [RTXBADFOOTER%] Invalid footer number
  2820.  
  2821.              Footer number supplied to RtxSetFooting is out of range 1..5.
  2822.  
  2823.  
  2824.         [RTXBADHEADER%] Invalid header number
  2825.  
  2826.              Header number supplied to RtxSetHeading is out of range 1..5.
  2827.  
  2828.  
  2829.         [RTXBADLEFT%] Invalid left margin
  2830.  
  2831.              Left margin value supplied  to RtxSetForm is  out of range 0  to
  2832.              form width set with the same call.
  2833.  
  2834.  
  2835.         [RTXBADLENGTH%] Invalid form length
  2836.  
  2837.              Form length value supplied to RtxSetForm is out of range 1..255.
  2838.  
  2839.  
  2840.         [RTXBADMASK%] Invalid or no mask specified
  2841.  
  2842.              Mask string supplied to RtxSetColumn is either invalid or null.
  2843.  
  2844.  
  2845.         [RTXBADPRINTER%] Invalid printer number
  2846.  
  2847.              Printer number supplied to RtxSetPrinter is out of range 1..3.
  2848.  
  2849.  
  2850.  
  2851.         =====================================================================
  2852.         Copyright 1992 by Cyberphilia, Inc.                         Page [41]
  2853.  
  2854.  
  2855.  
  2856.  
  2857.  
  2858.  
  2859.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2860.         =====================================================================
  2861.  
  2862.         [RTXBADROW%] Invalid row
  2863.  
  2864.              Row  number supplied  to RtxSetError  is out of  range 0  to the
  2865.              number of rows currently available on the screen.
  2866.  
  2867.  
  2868.         [RTXBADSKIP%] Invalid number of rows to skip
  2869.  
  2870.              1)   Rows specified to RtxSkip is  out of range -1 to  length of
  2871.                   form set with RtxSetForm.
  2872.  
  2873.              2)   Rows specified to RtxSetBreak is  out of range -1 to length
  2874.                   of form set with RtxSetForm.
  2875.          
  2876.  
  2877.         [RTXBADSOURCE%] Invalid source type
  2878.  
  2879.              Source type specified is out of range 1..6.
  2880.  
  2881.  
  2882.         [RTXBADSTYLE%] Invalid style
  2883.  
  2884.              Print style number specified is out of range 0..2.
  2885.  
  2886.  
  2887.         [RTXBADTOP%] Invalid top margin
  2888.  
  2889.              Top margin value  supplied to RtxSetForm  is out  of range 0  to
  2890.              length of form specified in the same call.
  2891.  
  2892.  
  2893.         [RTXBADTOTAL%] Columns with string data cannot be totalled
  2894.  
  2895.              The  source  data   type  of  the  column   being  defined  with
  2896.              RtxSetColumn is STRING and cannot be totalled.
  2897.  
  2898.  
  2899.         [RTXBADWIDTH%] Invalid form width (< 1 or > 255)
  2900.  
  2901.              Form width value supplied to RtxSetForm is out of range 1..255.
  2902.  
  2903.  
  2904.         [RTXFILEEXISTS%] FileSpec exists but Overwrite is FALSE.
  2905.  
  2906.              RtxOpen was called specifying that a report image  file residing
  2907.              on disk  with the same name should  not overwritten and the file
  2908.              exists.
  2909.  
  2910.  
  2911.         =====================================================================
  2912.         Copyright 1992 by Cyberphilia, Inc.                         Page [42]
  2913.  
  2914.  
  2915.  
  2916.  
  2917.  
  2918.  
  2919.         [Rtx] Report Toolbox for PDS v7.x                  PROGRAMMER'S GUIDE
  2920.         =====================================================================
  2921.  
  2922.         [RTXIOERROR%] Printer I/O error occurred
  2923.  
  2924.              A  printer i/o  error  occurred on  the  printer specified  with
  2925.              RtxSetPrinter while attempting to print a report with RtxClose.
  2926.  
  2927.  
  2928.         [RTXNOTONLINE%] Printer is not online
  2929.  
  2930.              The  printer specified with RtxSetPrinter is  not online or went
  2931.              offline in the midst of printing.
  2932.  
  2933.  
  2934.         [RTXNOTOPEN%] Report image has not yet been opened
  2935.  
  2936.              Requested operation  can only be performed once the report image
  2937.              file has been opened with RtxOpen.
  2938.  
  2939.  
  2940.         [RTXOUTOFPAPER%] Printer is out of paper
  2941.  
  2942.              The printer specified with RtxSetPrinter  is out of paper or ran
  2943.              out of paper in the midst of printing.
  2944.  
  2945.  
  2946.         [RTXSUCCESS%] Operation completed successfully
  2947.  
  2948.              The Rtx operation completed successfully without incident.
  2949.  
  2950.  
  2951.         [RTXTIMEOUT%] Printer timed out
  2952.  
  2953.              The printer  specified with  RtxSetPrinter has  timed out  while
  2954.              attempting to print a report.
  2955.  
  2956.  
  2957.         [RTXUNKNOWN%] An unknown error occurred while performing operation
  2958.  
  2959.              An unspecified  error, that is,  one not handled by  Rtx's error
  2960.              trapping routine has occurred.
  2961.  
  2962.  
  2963.  
  2964.  
  2965.  
  2966.  
  2967.  
  2968.  
  2969.  
  2970.  
  2971.         =====================================================================
  2972.         Copyright 1992 by Cyberphilia, Inc.                         Page [42]
  2973.  
  2974.  
  2975. ---------------------end of author's documentation-------------------
  2976.  
  2977. This program is distributed by Public (software) Library.
  2978. For a free copy of our monthly shareware review magazine with a listing
  2979. of more than 7000 programs, call or write:
  2980.  
  2981.                           Public (software) Library
  2982.                                 P.O.Box 35705
  2983.                             Houston, TX 77235-5705
  2984.                                  800-2424-PsL
  2985.                                  713-524-6394
  2986.                             FAX: 713-524-6398
  2987.                             CIS: 71355,470
  2988.